<!-- HTML header for doxygen 1.8.18-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Ipopt: Ipopt::RegisteredCategory Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 40px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Ipopt Documentation
   &#160;<!--span id="projectnumber">3.14.12</span-->
   </div>
  </td>
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classIpopt_1_1RegisteredCategory.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classIpopt_1_1RegisteredCategory-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Ipopt::RegisteredCategory Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A category of registered options.  
 <a href="classIpopt_1_1RegisteredCategory.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="IpRegOptions_8hpp_source.html">IpRegOptions.hpp</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Ipopt::RegisteredCategory:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classIpopt_1_1RegisteredCategory__inherit__graph.png" border="0" usemap="#Ipopt_1_1RegisteredCategory_inherit__map" alt="Inheritance graph"/></div>
<map name="Ipopt_1_1RegisteredCategory_inherit__map" id="Ipopt_1_1RegisteredCategory_inherit__map">
<area shape="rect" title="A category of registered options." alt="" coords="5,80,197,107"/>
<area shape="rect" href="classIpopt_1_1ReferencedObject.html" title="Storing the reference count of all the smart pointers that currently reference it." alt="" coords="12,5,191,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1RegisteredCategory_1_1ComparePriority.html">ComparePriority</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5e2c6c3dc25df89df5da757b9bec08bc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1RegisteredCategory.html#a5e2c6c3dc25df89df5da757b9bec08bc">RegisteredCategory</a> (const std::string &amp;name, int priority)</td></tr>
<tr class="memdesc:a5e2c6c3dc25df89df5da757b9bec08bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="classIpopt_1_1RegisteredCategory.html#a5e2c6c3dc25df89df5da757b9bec08bc">More...</a><br /></td></tr>
<tr class="separator:a5e2c6c3dc25df89df5da757b9bec08bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad097397b301fa91127c041dd31707deb"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1RegisteredCategory.html#ad097397b301fa91127c041dd31707deb">Name</a> () const</td></tr>
<tr class="memdesc:ad097397b301fa91127c041dd31707deb"><td class="mdescLeft">&#160;</td><td class="mdescRight">name of category  <a href="classIpopt_1_1RegisteredCategory.html#ad097397b301fa91127c041dd31707deb">More...</a><br /></td></tr>
<tr class="separator:ad097397b301fa91127c041dd31707deb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2310057ee367b2ab515514efb4a0aa12"><td class="memItemLeft" align="right" valign="top"><a class="el" href="IpTypes_8h.html#a24c578b20e2cd4eeb0060056ea13cbe5">IPOPT_DEPRECATED</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1RegisteredCategory.html#a2310057ee367b2ab515514efb4a0aa12">operator const std::string &amp;</a> () const</td></tr>
<tr class="memdesc:a2310057ee367b2ab515514efb4a0aa12"><td class="mdescLeft">&#160;</td><td class="mdescRight">name of category  <a href="classIpopt_1_1RegisteredCategory.html#a2310057ee367b2ab515514efb4a0aa12">More...</a><br /></td></tr>
<tr class="separator:a2310057ee367b2ab515514efb4a0aa12"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c4433ad924a44ef993a7852730f3c7d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="IpTypes_8h.html#a24c578b20e2cd4eeb0060056ea13cbe5">IPOPT_DEPRECATED</a> bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1RegisteredCategory.html#a2c4433ad924a44ef993a7852730f3c7d">operator!=</a> (const std::string &amp;other) const</td></tr>
<tr class="memdesc:a2c4433ad924a44ef993a7852730f3c7d"><td class="mdescLeft">&#160;</td><td class="mdescRight">compare with string  <a href="classIpopt_1_1RegisteredCategory.html#a2c4433ad924a44ef993a7852730f3c7d">More...</a><br /></td></tr>
<tr class="separator:a2c4433ad924a44ef993a7852730f3c7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3d04e4b9ea6c9285ff241208628ca52"><td class="memItemLeft" align="right" valign="top"><a class="el" href="IpTypes_8h.html#a24c578b20e2cd4eeb0060056ea13cbe5">IPOPT_DEPRECATED</a> bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1RegisteredCategory.html#aa3d04e4b9ea6c9285ff241208628ca52">operator==</a> (const std::string &amp;other) const</td></tr>
<tr class="memdesc:aa3d04e4b9ea6c9285ff241208628ca52"><td class="mdescLeft">&#160;</td><td class="mdescRight">compare with string  <a href="classIpopt_1_1RegisteredCategory.html#aa3d04e4b9ea6c9285ff241208628ca52">More...</a><br /></td></tr>
<tr class="separator:aa3d04e4b9ea6c9285ff241208628ca52"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab40d1d3cb7b30d7cae977056e8d0d013"><td class="memItemLeft" align="right" valign="top"><a class="el" href="IpTypes_8h.html#a24c578b20e2cd4eeb0060056ea13cbe5">IPOPT_DEPRECATED</a> bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1RegisteredCategory.html#ab40d1d3cb7b30d7cae977056e8d0d013">operator&lt;</a> (const <a class="el" href="classIpopt_1_1RegisteredCategory.html">RegisteredCategory</a> &amp;other) const</td></tr>
<tr class="memdesc:ab40d1d3cb7b30d7cae977056e8d0d013"><td class="mdescLeft">&#160;</td><td class="mdescRight">compare two categories  <a href="classIpopt_1_1RegisteredCategory.html#ab40d1d3cb7b30d7cae977056e8d0d013">More...</a><br /></td></tr>
<tr class="separator:ab40d1d3cb7b30d7cae977056e8d0d013"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a658b0be2592671eb6ba8c2f87771b13e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1RegisteredCategory.html#a658b0be2592671eb6ba8c2f87771b13e">Priority</a> () const</td></tr>
<tr class="memdesc:a658b0be2592671eb6ba8c2f87771b13e"><td class="mdescLeft">&#160;</td><td class="mdescRight">priority of category  <a href="classIpopt_1_1RegisteredCategory.html#a658b0be2592671eb6ba8c2f87771b13e">More...</a><br /></td></tr>
<tr class="separator:a658b0be2592671eb6ba8c2f87771b13e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae104718db68224519239d6710cab853b"><td class="memItemLeft" align="right" valign="top">const std::list&lt; <a class="el" href="classIpopt_1_1SmartPtr.html">SmartPtr</a>&lt; <a class="el" href="classIpopt_1_1RegisteredOption.html">RegisteredOption</a> &gt; &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1RegisteredCategory.html#ae104718db68224519239d6710cab853b">RegisteredOptions</a> () const</td></tr>
<tr class="memdesc:ae104718db68224519239d6710cab853b"><td class="mdescLeft">&#160;</td><td class="mdescRight">gives list of options in this category  <a href="classIpopt_1_1RegisteredCategory.html#ae104718db68224519239d6710cab853b">More...</a><br /></td></tr>
<tr class="separator:ae104718db68224519239d6710cab853b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classIpopt_1_1ReferencedObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classIpopt_1_1ReferencedObject')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classIpopt_1_1ReferencedObject.html">Ipopt::ReferencedObject</a></td></tr>
<tr class="memitem:a5c0f2208e3ead22bf7c5179381ed8203 inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1ReferencedObject.html#a5c0f2208e3ead22bf7c5179381ed8203">ReferencedObject</a> ()</td></tr>
<tr class="separator:a5c0f2208e3ead22bf7c5179381ed8203 inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbbf3aa5307da62ab8224ba599d4bd7a inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1ReferencedObject.html#adbbf3aa5307da62ab8224ba599d4bd7a">~ReferencedObject</a> ()</td></tr>
<tr class="separator:adbbf3aa5307da62ab8224ba599d4bd7a inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac517534e10e36c946aeefc6fe337777 inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1ReferencedObject.html#aac517534e10e36c946aeefc6fe337777">ReferenceCount</a> () const</td></tr>
<tr class="separator:aac517534e10e36c946aeefc6fe337777 inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa69ecb0f026bd741e2fa84c31d4ec332 inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1ReferencedObject.html#aa69ecb0f026bd741e2fa84c31d4ec332">AddRef</a> (const <a class="el" href="classIpopt_1_1Referencer.html">Referencer</a> *referencer) const</td></tr>
<tr class="separator:aa69ecb0f026bd741e2fa84c31d4ec332 inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6c952e7d1a63080dc8f121c008944fc inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1ReferencedObject.html#ae6c952e7d1a63080dc8f121c008944fc">ReleaseRef</a> (const <a class="el" href="classIpopt_1_1Referencer.html">Referencer</a> *referencer) const</td></tr>
<tr class="separator:ae6c952e7d1a63080dc8f121c008944fc inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:ac8654952daca10e6755f2eb1431e2798"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1RegisteredCategory.html#ac8654952daca10e6755f2eb1431e2798">RegisteredCategory</a> ()</td></tr>
<tr class="memdesc:ac8654952daca10e6755f2eb1431e2798"><td class="mdescLeft">&#160;</td><td class="mdescRight">unimplemented default constructor  <a href="classIpopt_1_1RegisteredCategory.html#ac8654952daca10e6755f2eb1431e2798">More...</a><br /></td></tr>
<tr class="separator:ac8654952daca10e6755f2eb1431e2798"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73a1d789578c19e1de2fd84c870552e0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1RegisteredCategory.html#a73a1d789578c19e1de2fd84c870552e0">RegisteredCategory</a> (const <a class="el" href="classIpopt_1_1RegisteredCategory.html">RegisteredCategory</a> &amp;)</td></tr>
<tr class="memdesc:a73a1d789578c19e1de2fd84c870552e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">unimplemented copy constructor  <a href="classIpopt_1_1RegisteredCategory.html#a73a1d789578c19e1de2fd84c870552e0">More...</a><br /></td></tr>
<tr class="separator:a73a1d789578c19e1de2fd84c870552e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b6979970ad525887c37539ac14cca8a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classIpopt_1_1RegisteredCategory.html">RegisteredCategory</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1RegisteredCategory.html#a2b6979970ad525887c37539ac14cca8a">operator=</a> (const <a class="el" href="classIpopt_1_1RegisteredCategory.html">RegisteredCategory</a> &amp;)</td></tr>
<tr class="memdesc:a2b6979970ad525887c37539ac14cca8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">unimplemented assignment operator  <a href="classIpopt_1_1RegisteredCategory.html#a2b6979970ad525887c37539ac14cca8a">More...</a><br /></td></tr>
<tr class="separator:a2b6979970ad525887c37539ac14cca8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:aff0aee83dab3f64b0445435d6e946cfe"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1RegisteredCategory.html#aff0aee83dab3f64b0445435d6e946cfe">name_</a></td></tr>
<tr class="memdesc:aff0aee83dab3f64b0445435d6e946cfe"><td class="mdescLeft">&#160;</td><td class="mdescRight">name of category  <a href="classIpopt_1_1RegisteredCategory.html#aff0aee83dab3f64b0445435d6e946cfe">More...</a><br /></td></tr>
<tr class="separator:aff0aee83dab3f64b0445435d6e946cfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1acb644dd18e491c7395e8f04982f2a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1RegisteredCategory.html#ab1acb644dd18e491c7395e8f04982f2a">priority_</a></td></tr>
<tr class="memdesc:ab1acb644dd18e491c7395e8f04982f2a"><td class="mdescLeft">&#160;</td><td class="mdescRight">priority of category (used to decide whether to print and printing order)  <a href="classIpopt_1_1RegisteredCategory.html#ab1acb644dd18e491c7395e8f04982f2a">More...</a><br /></td></tr>
<tr class="separator:ab1acb644dd18e491c7395e8f04982f2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa0aecaeb261e8b8d90c7e740e3d9352e"><td class="memItemLeft" align="right" valign="top">std::list&lt; <a class="el" href="classIpopt_1_1SmartPtr.html">SmartPtr</a>&lt; <a class="el" href="classIpopt_1_1RegisteredOption.html">RegisteredOption</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1RegisteredCategory.html#aa0aecaeb261e8b8d90c7e740e3d9352e">regoptions_</a></td></tr>
<tr class="memdesc:aa0aecaeb261e8b8d90c7e740e3d9352e"><td class="mdescLeft">&#160;</td><td class="mdescRight">options of this category  <a href="classIpopt_1_1RegisteredCategory.html#aa0aecaeb261e8b8d90c7e740e3d9352e">More...</a><br /></td></tr>
<tr class="separator:aa0aecaeb261e8b8d90c7e740e3d9352e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a6cdca39d68b836f63a73424adb096483"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1RegisteredCategory.html#a6cdca39d68b836f63a73424adb096483">RegisteredOptions</a></td></tr>
<tr class="separator:a6cdca39d68b836f63a73424adb096483"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A category of registered options. </p>
<dl class="section since"><dt>Since</dt><dd>3.14.0 </dd></dl>

<p class="definition">Definition at line <a class="el" href="IpRegOptions_8hpp_source.html#l00036">36</a> of file <a class="el" href="IpRegOptions_8hpp_source.html">IpRegOptions.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5e2c6c3dc25df89df5da757b9bec08bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e2c6c3dc25df89df5da757b9bec08bc">&#9670;&nbsp;</a></span>RegisteredCategory() <span class="overload">[1/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Ipopt::RegisteredCategory::RegisteredCategory </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>priority</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Constructor. </p>
<p>Use negative value for priority to suppress it being included in documentation. </p>

<p class="definition">Definition at line <a class="el" href="IpRegOptions_8hpp_source.html#l00043">43</a> of file <a class="el" href="IpRegOptions_8hpp_source.html">IpRegOptions.hpp</a>.</p>

</div>
</div>
<a id="ac8654952daca10e6755f2eb1431e2798"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8654952daca10e6755f2eb1431e2798">&#9670;&nbsp;</a></span>RegisteredCategory() <span class="overload">[2/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Ipopt::RegisteredCategory::RegisteredCategory </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>unimplemented default constructor </p>

</div>
</div>
<a id="a73a1d789578c19e1de2fd84c870552e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73a1d789578c19e1de2fd84c870552e0">&#9670;&nbsp;</a></span>RegisteredCategory() <span class="overload">[3/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Ipopt::RegisteredCategory::RegisteredCategory </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classIpopt_1_1RegisteredCategory.html">RegisteredCategory</a> &amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>unimplemented copy constructor </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad097397b301fa91127c041dd31707deb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad097397b301fa91127c041dd31707deb">&#9670;&nbsp;</a></span>Name()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const std::string&amp; Ipopt::RegisteredCategory::Name </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>name of category </p>

<p class="definition">Definition at line <a class="el" href="IpRegOptions_8hpp_source.html#l00052">52</a> of file <a class="el" href="IpRegOptions_8hpp_source.html">IpRegOptions.hpp</a>.</p>

</div>
</div>
<a id="a2310057ee367b2ab515514efb4a0aa12"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2310057ee367b2ab515514efb4a0aa12">&#9670;&nbsp;</a></span>operator const std::string &amp;()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="IpTypes_8h.html#a24c578b20e2cd4eeb0060056ea13cbe5">IPOPT_DEPRECATED</a> Ipopt::RegisteredCategory::operator const std::string &amp; </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>name of category </p>
<p>This one is for backward-compatibility with previous <a class="el" href="namespaceIpopt.html" title="This file contains a base class for all exceptions and a set of macros to help with exceptions.">Ipopt</a> versions where <a class="el" href="classIpopt_1_1RegisteredCategory.html" title="A category of registered options.">RegisteredCategory</a> was a string. </p><dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000003">Deprecated:</a></b></dt><dd>Use <a class="el" href="classIpopt_1_1RegisteredCategory.html#ad097397b301fa91127c041dd31707deb" title="name of category">Name()</a> instead. </dd></dl>

<p class="definition">Definition at line <a class="el" href="IpRegOptions_8hpp_source.html#l00062">62</a> of file <a class="el" href="IpRegOptions_8hpp_source.html">IpRegOptions.hpp</a>.</p>

</div>
</div>
<a id="a2c4433ad924a44ef993a7852730f3c7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c4433ad924a44ef993a7852730f3c7d">&#9670;&nbsp;</a></span>operator!=()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="IpTypes_8h.html#a24c578b20e2cd4eeb0060056ea13cbe5">IPOPT_DEPRECATED</a> bool Ipopt::RegisteredCategory::operator!= </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>other</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>compare with string </p>
<p>This one is for backward-compatibility with previous <a class="el" href="namespaceIpopt.html" title="This file contains a base class for all exceptions and a set of macros to help with exceptions.">Ipopt</a> versions where <a class="el" href="classIpopt_1_1RegisteredCategory.html" title="A category of registered options.">RegisteredCategory</a> was a string. </p><dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000004">Deprecated:</a></b></dt><dd>Use <a class="el" href="classIpopt_1_1RegisteredCategory.html#ad097397b301fa91127c041dd31707deb" title="name of category">Name()</a> and string comparison instead. </dd></dl>

<p class="definition">Definition at line <a class="el" href="IpRegOptions_8hpp_source.html#l00072">72</a> of file <a class="el" href="IpRegOptions_8hpp_source.html">IpRegOptions.hpp</a>.</p>

</div>
</div>
<a id="aa3d04e4b9ea6c9285ff241208628ca52"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3d04e4b9ea6c9285ff241208628ca52">&#9670;&nbsp;</a></span>operator==()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="IpTypes_8h.html#a24c578b20e2cd4eeb0060056ea13cbe5">IPOPT_DEPRECATED</a> bool Ipopt::RegisteredCategory::operator== </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>other</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>compare with string </p>
<p>This one is for backward-compatibility with previous <a class="el" href="namespaceIpopt.html" title="This file contains a base class for all exceptions and a set of macros to help with exceptions.">Ipopt</a> versions where <a class="el" href="classIpopt_1_1RegisteredCategory.html" title="A category of registered options.">RegisteredCategory</a> was a string. </p><dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000005">Deprecated:</a></b></dt><dd>Use <a class="el" href="classIpopt_1_1RegisteredCategory.html#ad097397b301fa91127c041dd31707deb" title="name of category">Name()</a> and string comparison instead. </dd></dl>

<p class="definition">Definition at line <a class="el" href="IpRegOptions_8hpp_source.html#l00084">84</a> of file <a class="el" href="IpRegOptions_8hpp_source.html">IpRegOptions.hpp</a>.</p>

</div>
</div>
<a id="ab40d1d3cb7b30d7cae977056e8d0d013"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab40d1d3cb7b30d7cae977056e8d0d013">&#9670;&nbsp;</a></span>operator&lt;()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="IpTypes_8h.html#a24c578b20e2cd4eeb0060056ea13cbe5">IPOPT_DEPRECATED</a> bool Ipopt::RegisteredCategory::operator&lt; </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classIpopt_1_1RegisteredCategory.html">RegisteredCategory</a> &amp;&#160;</td>
          <td class="paramname"><em>other</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>compare two categories </p>
<p>This one is for backward-compatibility with previous <a class="el" href="namespaceIpopt.html" title="This file contains a base class for all exceptions and a set of macros to help with exceptions.">Ipopt</a> versions where <a class="el" href="classIpopt_1_1RegisteredCategory.html" title="A category of registered options.">RegisteredCategory</a> was a string. </p><dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000006">Deprecated:</a></b></dt><dd>Use <a class="el" href="classIpopt_1_1RegisteredCategory.html#ad097397b301fa91127c041dd31707deb" title="name of category">Name()</a> and string comparison on them instead. </dd></dl>

<p class="definition">Definition at line <a class="el" href="IpRegOptions_8hpp_source.html#l00096">96</a> of file <a class="el" href="IpRegOptions_8hpp_source.html">IpRegOptions.hpp</a>.</p>

</div>
</div>
<a id="a658b0be2592671eb6ba8c2f87771b13e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a658b0be2592671eb6ba8c2f87771b13e">&#9670;&nbsp;</a></span>Priority()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int Ipopt::RegisteredCategory::Priority </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>priority of category </p>

<p class="definition">Definition at line <a class="el" href="IpRegOptions_8hpp_source.html#l00104">104</a> of file <a class="el" href="IpRegOptions_8hpp_source.html">IpRegOptions.hpp</a>.</p>

</div>
</div>
<a id="ae104718db68224519239d6710cab853b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae104718db68224519239d6710cab853b">&#9670;&nbsp;</a></span>RegisteredOptions()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const std::list&lt;<a class="el" href="classIpopt_1_1SmartPtr.html">SmartPtr</a>&lt;<a class="el" href="classIpopt_1_1RegisteredOption.html">RegisteredOption</a>&gt; &gt;&amp; Ipopt::RegisteredCategory::RegisteredOptions </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>gives list of options in this category </p>

<p class="definition">Definition at line <a class="el" href="IpRegOptions_8hpp_source.html#l00110">110</a> of file <a class="el" href="IpRegOptions_8hpp_source.html">IpRegOptions.hpp</a>.</p>

</div>
</div>
<a id="a2b6979970ad525887c37539ac14cca8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b6979970ad525887c37539ac14cca8a">&#9670;&nbsp;</a></span>operator=()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classIpopt_1_1RegisteredCategory.html">RegisteredCategory</a>&amp; Ipopt::RegisteredCategory::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classIpopt_1_1RegisteredCategory.html">RegisteredCategory</a> &amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>unimplemented assignment operator </p>

</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a6cdca39d68b836f63a73424adb096483"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6cdca39d68b836f63a73424adb096483">&#9670;&nbsp;</a></span>RegisteredOptions</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">friend class <a class="el" href="classIpopt_1_1RegisteredOptions.html">RegisteredOptions</a></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="IpRegOptions_8hpp_source.html#l00038">38</a> of file <a class="el" href="IpRegOptions_8hpp_source.html">IpRegOptions.hpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aff0aee83dab3f64b0445435d6e946cfe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff0aee83dab3f64b0445435d6e946cfe">&#9670;&nbsp;</a></span>name_</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::string Ipopt::RegisteredCategory::name_</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>name of category </p>

<p class="definition">Definition at line <a class="el" href="IpRegOptions_8hpp_source.html#l00139">139</a> of file <a class="el" href="IpRegOptions_8hpp_source.html">IpRegOptions.hpp</a>.</p>

</div>
</div>
<a id="ab1acb644dd18e491c7395e8f04982f2a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab1acb644dd18e491c7395e8f04982f2a">&#9670;&nbsp;</a></span>priority_</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int Ipopt::RegisteredCategory::priority_</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>priority of category (used to decide whether to print and printing order) </p>

<p class="definition">Definition at line <a class="el" href="IpRegOptions_8hpp_source.html#l00142">142</a> of file <a class="el" href="IpRegOptions_8hpp_source.html">IpRegOptions.hpp</a>.</p>

</div>
</div>
<a id="aa0aecaeb261e8b8d90c7e740e3d9352e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0aecaeb261e8b8d90c7e740e3d9352e">&#9670;&nbsp;</a></span>regoptions_</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::list&lt;<a class="el" href="classIpopt_1_1SmartPtr.html">SmartPtr</a>&lt;<a class="el" href="classIpopt_1_1RegisteredOption.html">RegisteredOption</a>&gt; &gt; Ipopt::RegisteredCategory::regoptions_</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>options of this category </p>

<p class="definition">Definition at line <a class="el" href="IpRegOptions_8hpp_source.html#l00145">145</a> of file <a class="el" href="IpRegOptions_8hpp_source.html">IpRegOptions.hpp</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/Common/<a class="el" href="IpRegOptions_8hpp_source.html">IpRegOptions.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
</body>
</html>
